Conversation
There was a problem hiding this comment.
Code Review
The pull request introduces comprehensive documentation for A2UI Catalogs, which is a valuable addition. The content is well-structured and covers essential aspects like negotiation and versioning. However, there are several inconsistencies in filenames (e.g., standard_catalog_definition.json vs standard_catalog.json) and fragile links to specific line numbers in the JSON schema files. Additionally, some examples contain version mismatches (v0.8 vs v0.9) that should be corrected for clarity.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/catalogs.md (9)
Linking to specific line numbers (e.g., #L62C5-L95C6) in a JSON schema file is fragile. If the schema is updated, these links will likely point to incorrect or irrelevant sections. Consider linking to the file directly or using a more stable reference if the documentation tool supports it. This applies to lines 11 and 91 as well.
docs/catalogs.md (165)
The reference to standard_catalog_definition.json is inconsistent with the actual filename standard_catalog.json used in the v0.9 specification and referenced earlier in this document (line 62).
{ "$ref": "standard_catalog.json#/components" },
docs/catalogs.md (193-194)
The references to standard_catalog_definition.json should be updated to standard_catalog.json to match the v0.9 naming convention.
{ "$ref": "standard_catalog.json#/components/Text" },
{ "$ref": "standard_catalog.json#/components/Icon" },
docs/catalogs.md (250)
The URI https://a2ui.org/a2a-extension/a2ui/v0.8 refers to version v0.8, but this documentation is specifically for version v0.9. This might lead to confusion regarding which protocol version is being described in the example.
"uri": "https://a2ui.org/a2a-extension/a2ui/v0.9",
docs/catalogs.md (298)
The catalogId in this example uses the v0.8 filename standard_catalog_definition.json. It should be updated to standard_catalog.json for consistency with the v0.9 specification.
"catalogId": "https://a2ui.org/.../standard_catalog.json"
docs/file.json (1)
The filename file.json is too generic and does not describe the purpose of the file. Based on its content, it appears to be an example of a cherry-picked catalog. Consider renaming it to something more descriptive like cherry_picked_catalog_example.json.
No description provided.